home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / PCB0203M.ZIP / PCBEDIT.DOC < prev    next >
Text File  |  1993-11-12  |  29KB  |  758 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                                     PCBEdit
  22.  
  23.                                   Version 1.10
  24.  
  25.                                  Beta Release 2
  26.  
  27.                                 12 November 1993
  28.  
  29.  
  30.  
  31.               Copyright (C) 1993, Clark Development Company, Inc.
  32.  
  33.                         Clark Development Company, Inc.
  34.                                 P.O. Box 571365
  35.                              Murray, UT  84157-1365
  36.  
  37.                              Sales - (800) 356-1686
  38.                               FAX - (801) 261-8987
  39.                          Voice Support - (801) 261-1686
  40.                           BBS Support - (801) 261-8976
  41.  
  42.                          Written by Scott Dale Robison
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.                             LICENSE TO USE AGREEMENT
  54.                             ------------------------
  55.  
  56.  
  57. Clark Development Company (CDC) grants to the purchaser of PCBoard
  58.  
  59. Professional Bulletin Board Software (PCBoard) a nonexclusive license to
  60.  
  61. use PCBEdit.  PCBEdit may only be used by purchasers of PCBoard.
  62.  
  63. Contact CDC for purchasing information.  The purchaser is licensed to
  64.  
  65. use PCBEdit according to the same terms and conditions as found in the
  66.  
  67. PCBoard LICENSE TO USE AGREEMENT located on the software envelope
  68.  
  69. included with your PCBoard package.
  70.  
  71.  
  72. If the purchaser transfers ownership of PCBoard to another party, the
  73.  
  74. right to use PCBEdit is also transferred.
  75.  
  76.  
  77. PCBEdit is provided at no cost to purchasers of PCBoard.  CDC makes no
  78.  
  79. warranties of any kind, expressed or implied, with respect to the
  80.  
  81. quality, performance, accuracy, or fitness of PCBEdit.  CDC assumes no
  82.  
  83. responsibility for any decisions made or actions taken on the part of
  84.  
  85. the purchaser because of the use of PCBEdit.  In no event shall CDC, or
  86.  
  87. any of its representatives, be liable for any loss of profit or damage
  88.  
  89. arising from the use or inability to use PCBEdit even if CDC or an
  90.  
  91. authorized agent of CDC has been advised of the possibility of damage.
  92.  
  93.  
  94. CDC reserves the right to make changes, enhancements, and improvements
  95.  
  96. to PCBEdit at any time and without notice.
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.                                  USING PCBEDIT
  104.                                  -------------
  105.  
  106. The documentation for PCBEdit is still under development.  However,
  107. since you've all been clamoring for it for *SO* long now, we've decided
  108. to go ahead and make it available for you to use right now, rather than
  109. forcing you to wait for PCBoard Version 15 to be released.
  110.  
  111. PCBEdit is not meant to replace programs such as TheDraw (TheSoft
  112. Programming Services/Ian E. Davis), PCBDraw (Jim Dailey) and TDXL (Fred
  113. Bertagnolli).  They are still incredibly useful for screen design.
  114. PCBEdit is designed to allow you to write what we call "information
  115. intensive" display files (such as NEWS and BLT files), as opposed to
  116. "display intensive" files (such as WELCOME and BRDM.)
  117.  
  118. PCBEdit should be installed in your PCB subdirectory (or whereever you
  119. have installed your PCBoard EXE files.)  It may be set up as an editor
  120. in PCBoard System Manager (PCBSM) option G (Define Text & Graphics
  121. Editors.)  Because it deals with @X codes and @ macros, it can be used
  122. to design all files, eliminating the need for separate graphics display
  123. files.
  124.  
  125. PCBEdit is used just as you would use any editor:  PCBEDIT FILENAME.  It
  126. supports many configuration options which may be specified either on the
  127. command line, in an environment variable, or in a configuration file.
  128. (More on this later.)
  129.  
  130. A couple of notes on getting help.  First, there is a complete reference
  131. of commands and configuration options available via the Alt-H key when
  132. editing.  Alt-W goes to an information screen.
  133.  
  134.  
  135.  
  136.                                 STARTING PCBEDIT
  137.                                 ----------------
  138.  
  139. The PCBEdit command line takes the following format:
  140.  
  141.     PCBEDIT [/OPTION ...] [FILENAME]
  142.  
  143. The following are valid /option's:
  144.  
  145.     /AT                 /ATMAC              /ATX                /BAK
  146.     /BUZZ               /CATTR              /COLOR              /DIALOGATTR
  147.     /DIALOGDIRATTR      /DIALOGDRVATTR      /DIALOGFILEATTR     /DIALOGHLATTR
  148.     /DIALOGOPTATTR      /DOS                /HELPATTR           /HELPHLATTR
  149.     /IO                 /LLEND              /MACRO              /MATTR
  150.     /MONO               /NOAT               /NOATX              /NOBAK
  151.     /NOBUZZ             /NODOS              /NOIO               /NOQUICK
  152.     /NOSNOW             /QUICK              /RIBATTR            /RIBHLATTR
  153.     /SET                /SNOW               /STARTATTR          /STATATTR
  154.     /STATUS             /STRIPG             /TRYNOG             /USEG
  155.     REM /
  156.  
  157. Any valid DOS filename may be used.  [Of course, you probably don't want
  158. to use PCBEdit to edit an EXE or COM file!]  :)
  159.  
  160.                                 STARTUP OPTIONS
  161.                                 ---------------
  162.  
  163. /AT - /AT
  164.     Forces PCBEdit to interpret @ macros (and @X codes if /ATX is in
  165.     effect).  (Default)
  166.  
  167. /ATMAC - /ATMAC:@MAC@[:TEXT]
  168.     Replaces the default text (used to preview a file) associated with
  169.     the specified @ macro with new text.
  170.         @MAC@ -- the @ macro to modify
  171.         TEXT -- (optional) the new default text (for preview purposes)
  172.             to assign to @MAC@; if not specified, reverts to the
  173.             original default text
  174.  
  175. /ATX - /ATX
  176.     If /AT is in effect, forces PCBEdit to interpret @X codes.
  177.     (Default)
  178.  
  179. /BAK - /BAK
  180.     Forces PCBEdit to keep backup files.  (Default)
  181.  
  182. /BUZZ - /BUZZ
  183.     Enables a buzzing sound to alert the user to error conditions.
  184.     (Default)
  185.  
  186. /CATTR - /CATTR
  187.     Updates all configurable attributes with default values for a color
  188.     display adapter.  (Default)
  189.  
  190. /COLOR - /COLOR
  191.     Forces PCBEdit to use a color display adapter card.
  192.  
  193. /DIALOGATTR - /DIALOGATTR:ATTR
  194.     Changes the default attribute used for the file select dialog
  195.     screen.
  196.         ATTR -- the decimal value of the new attribute to use
  197.  
  198. /DIALOGDIRATTR - /DIALOGDIRATTR:ATTR
  199.     Changes the default attribute used for displaying directory names on
  200.     the file select dialog screen.
  201.         ATTR -- the decimal value of the new attribute to use
  202.  
  203. /DIALOGDRVATTR - /DIALOGDRVATTR:ATTR
  204.     Changes the default attribute used for displaying drive letters on
  205.     the file select dialog screen.
  206.         ATTR -- the decimal value of the new attribute to use
  207.  
  208. /DIALOGFILEATTR - /DIALOGFILEATTR:ATTR
  209.     Changes the default attribute used for displaying file names on the
  210.     file select dialog screen.
  211.         ATTR -- the decimal value of the new attribute to use
  212.  
  213. /DIALOGHLATTR - /DIALOGHLATTR:ATTR
  214.     Changes the default attribute used for displaying highlighted items
  215.     on the file select dialog screen.
  216.         ATTR -- the decimal value of the new attribute to use
  217.  
  218. /DIALOGOPTATTR - /DIALOGOPTATTR:ATTR
  219.     Changes the default attribute used for displaying command options on
  220.     the file select dialog screen.
  221.         ATTR -- the decimal value of the new attribute to use
  222.  
  223. /DOS - /DOS
  224.     Forces PCBEdit to allow shells to DOS.  (Default)
  225.  
  226. /HELPATTR - /HELPATTR:ATTR
  227.     Changes the default attribute used for help screens.
  228.         ATTR -- the decimal value of the new attribute to use
  229.  
  230. /HELPHLATTR - /HELPHLATTR:ATTR
  231.     Changes the default attribute used for highlighted portions of
  232.     help screens.
  233.         ATTR -- the decimal value of the new attribute to use
  234.  
  235. /IO - /IO
  236.     Allows all normal file input/output operations.  (Default)
  237.  
  238. /LLEND - /LLEND:ASC[;ASC[...]]
  239.     Specifies a different character sequence to be appended to the last
  240.     line of a file.  (By default, the last line is written with a
  241.     carriage return/ line feed appended to it.  With this switch, you
  242.     can change it to several carriage return/line feed pairs, an end of
  243.     file character, etc.)
  244.         ASC -- any valid decimal ASCII code (0 - 255)
  245.  
  246. /MACRO - /MACRO:FILENAME.EXT
  247.     Loads the specified macro file.
  248.         FILENAME.EXT -- a valid DOS filename used to specify the desired
  249.             macro file
  250.  
  251. /MATTR - /MATTR
  252.     Updates all configurable attributes with default values for a
  253.     monochrome display adapter.
  254.  
  255. /MONO - /MONO
  256.     Forces PCBEdit to use a monochrome display adapter card.
  257.  
  258. /NOAT - /NOAT
  259.     Forces PCBEdit to not interpret @ macros or @X codes (regardless of
  260.     whether or not /ATX is in effect).
  261.  
  262. /NOATX - /NOATX
  263.     Forces PCBEdit to ignore @X codes and to display all text in the
  264.     attribute specified via the /STARTATTR option.
  265.  
  266. /NOBAK - /NOBAK
  267.     Forces PCBEdit to not keep backup files.
  268.  
  269. /NOBUZZ - /NOBUZZ
  270.     Disables the buzzing sound for alerting the user about error
  271.     conditions.
  272.  
  273. /NODOS - /NODOS
  274.     Forces PCBEdit to not allow shells to DOS.
  275.  
  276. /NOIO - /NOIO
  277.     Disables the Alt-I, Alt-K and Alt-L functions.  Also disables the
  278.     ability to specify the filename to save in the Alt-S function.
  279.  
  280. /NOQUICK - /NOQUICK
  281.     Displays the welcome screen when PCBEdit starts.
  282.  
  283. /NOSNOW - /NOSNOW
  284.     Tells PCBEdit to not test for CGA screen snow.  (Default)
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291. /NOSS - /NOSS
  292.     Tells PCBEdit to not strip trailing spaces from lines.
  293.  
  294. /QUICK - /QUICK
  295.     Circumvents display of the welcome screen at program start.
  296.     (Default)
  297.  
  298. /RIBATTR - /RIBATTR:ATTR
  299.     Changes the default attribute used for the code ribbon.
  300.         ATTR -- the decimal value of the new attribute to use
  301.  
  302. /RIBHLATTR - /RIBHLATTR:ATTR
  303.     Changes the default attribute used for the high-lighted portion of
  304.     the code ribbon.
  305.         ATTR -- the decimal value of the new attribute to use
  306.  
  307. /SET - /SET:FILENAME.EXT
  308.     Loads the specified function key character set file.
  309.         FILENAME.EXT -- a valid DOS filename used to specify the desired
  310.             function key character set file
  311.  
  312. /SNOW - /SNOW
  313.     Tells PCBEdit to test for CGA screen snow.
  314.  
  315. /SS - /SS
  316.     Tells PCBEdit to strip trailing spaces from lines.
  317.  
  318. /STARTATTR - /STARTATTR:ATTR
  319.     Changes the default attribute used for the edit buffer.
  320.         ATTR -- the decimal value of the new attribute to use
  321.  
  322. /STATATTR - /STATATTR:ATTR
  323.     Changes the default attribute used for the status line.
  324.         ATTR -- the decimal value of the new attribute to use
  325.  
  326. /STATUS - /STATUS:TYPE
  327.     Changes the default status bar type.
  328.         TYPE -- one of the following:
  329.             0 = detailed status bar with code ribbon  (Default)
  330.             1 = function key status bar with code ribbon
  331.             2 = no status bar or code ribbon
  332.  
  333. /STRIPG - /STRIPG
  334.     Always strip the G graphics file specification (if present) prior to
  335.     attempting a file load.
  336.  
  337. /TRYNOG - /TRYNOG
  338.     Strip the G graphics file specification (if present) if a file with
  339.     the G as part of the filename doesn't exist.
  340.  
  341. /USEG - /USEG
  342.     Never automatically strip the G graphics file specification.
  343.     (Default)
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350. REM /... - REM /COLOR
  351.     Removes the startup option temporarily from processing (works with
  352.     any option that begins with a forward slash [/], including options
  353.     not currently defined [REM /BOB]).
  354.  
  355.  
  356. If you need to enter a startup option that with an embedded space,
  357. surround the entire option with quotes.  Quotes cannot be included in an
  358. option. For example:
  359.  
  360.     PCBEDIT "/ATMAC:@USER@:SCOTT ROBISON"
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.                            SPECIFYING STARTUP OPTIONS
  368.                            --------------------------
  369.  
  370. There are three ways of specifying startup options.  The first is on the
  371. PCBEdit command line.  For example:
  372.  
  373.     PCBEDIT /NOQUICK /MACRO:MAIN.MAC /SET:MAIN.SET NEWSG
  374.  
  375. The second means of specifying startup options is through the PCBEDIT
  376. environment variable, which you could SET in your AUTOEXEC.BAT file.  An
  377. example line would look like this:
  378.  
  379.     SET PCBEDIT=/QUICK "/ATMAC:@USER@:SCOTT ROBISON"
  380.  
  381. Finally, startup options may be specified in a a configuration file.  It
  382. is named PCBEDIT.CFG and can be located in the same directory as
  383. PCBEDIT.EXE or in the current directory.  It can be created with any
  384. text editor, may have as many lines as necessary, and may have several
  385. options on one line, as long as all lines are limited to 127 characters
  386. or less.  Here's an example:
  387.  
  388.     +----------------------------------------------------------------------+
  389.     |                                                                      |
  390.     |  /QUICK /MACRO:MAIN.MAC /SET:MAIN.SET                                |
  391.     |  "/ATMAC:@USER@:SCOTT ROBISON"  /ATMAC:@FIRSTU@:SCOTT                |
  392.     |  /ATMAC:@FIRST@:Scott  REM /NOQUICK  /CATTR NEWSG                    |
  393.     |                                                                      |
  394.     +----------------------------------------------------------------------+
  395.  
  396. PCBEdit searches for startup options in the following order:
  397. PCBEDIT.CFG (first in directory with PCBEdit, then in the current
  398. directory); PCBEDIT environment variable; PCBEDIT command line.  In this
  399. way, an option in the PCBEDIT.EXE directory configuration file can be
  400. overridden by another option later in the same file, in the other
  401. configuration file, environment variable or command line; an option in
  402. the current directory configuration file can be overridden by an option
  403. later in the same file, in the environment variable or on the command
  404. line, and so on.
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.                                  PCBEDIT MACROS
  412.                                  --------------
  413.  
  414. Fifteen sets of user-defined macros are supported by PCBoard.  Each set
  415. consists of ten strings that may be accessed via the F1 - F10 function
  416. keys. Different sets may be accessed by utilizing the
  417. Shift-Alt-F1 - Shift-Alt-F10 keys for sets 1 - 10 and the
  418. Shift-^F1 - Shift-^F5 keys for sets 11 - 15.  The macros may be selected
  419. from and maintained with the Alt-G key.  Each macro may consist of
  420. whatever text the user would like.  Additionally, the following special
  421. sequences are recognized by PCBEdit:
  422.  
  423.     \XXXX - Backslash followed by 4 hex digits will be converted to a
  424.             keyboard code and stuffed in the keyboard buffer (Sorry, no
  425.             list of keyboard codes yet; they will be forthcoming)
  426.  
  427.     \X    - Stuffs the character following backslash in the keyboard
  428.             buffer (\\ to stuff a literal backslash)
  429.  
  430.     \     - By itself at the end of a macro with nothing following it
  431.             will stuff a literal backslash in the keyboard buffer
  432.  
  433.     ~X    - Stuffs the lowercase letter X in the keyboard buffer
  434.  
  435.     ~#    - Stuffs the code for function key F# in the keyboard buffer
  436.  
  437.     ~     - By itself at the end of a macro with nothing following it
  438.             will stuff a literal tilde in the keyboard buffer
  439.  
  440.     #X    - Stuffs the uppercase letter X in the keyboard buffer
  441.  
  442.     ##    - Stuffs the code for function key Shift-F# in the keyboard
  443.             buffer
  444.  
  445.     #     - By itself at the end of a macro with nothing following it
  446.             will stuff a literal pound sign in the keyboard buffer
  447.  
  448.     ^X    - Stuffs a control X in the keyboard buffer
  449.  
  450.     ^#    - Stuffs the code for function key control F# in the keyboard
  451.             buffer
  452.  
  453.     ^     - By itself at the end of a macro with nothing following it
  454.             will stuff a literal carat in the keyboard buffer
  455.  
  456.     !X    - Stuffs an alt X in the keyboard buffer
  457.  
  458.     !#    - Stuffs the code for function key alt F# in the keyboard
  459.             buffer
  460.  
  461.     !     - By itself at the end of a macro with nothing following it
  462.             will stuff a literal exclamation point in the keyboard
  463.             buffer
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.                             KEYCODE TABLE FOR MACROS
  471.                             ------------------------
  472.  
  473.  
  474.    Ctrl-A = ^A   Alt-A = !A   Backspace  = ^H      Backslash         (\) = \\
  475.    Ctrl-B = ^B   Alt-B = !B   TAB        = ^I      Tilde             (~) = \~
  476.    Ctrl-C = ^C   Alt-C = !C   Line Feed  = ^J      Pound Sign        (#) = \#
  477.    Ctrl-D = ^D   Alt-D = !D   ^ENTER     = ^J      Carat             (^) = \^
  478.    Ctrl-E = ^E   Alt-E = !E   ENTER      = ^M      Exclamation Point (!) = \!
  479.    Ctrl-F = ^F   Alt-F = !F   ESC        = \001B
  480.    Ctrl-G = ^G     Alt-G = !G
  481.    Ctrl-H = ^H     Alt-H = !H   Shift-TAB  = \010F
  482.    Ctrl-I = ^I   Alt-I = !I
  483.    Ctrl-J = ^J     Alt-J = !J   INS         = \0152
  484.    Ctrl-K = ^K     Alt-K = !K   DEL         = \0153
  485.    Ctrl-L = ^L   Alt-L = !L
  486.    Ctrl-M = ^M   Alt-M = !M   LEFT       = \014B   Ctrl-LEFT  = \0173
  487.    Ctrl-N = ^N   Alt-N = !N   RIGHT      = \014D   Ctrl-RIGHT = \0174
  488.    Ctrl-O = ^O   Alt-O = !O   UP         = \0148
  489.    Ctrl-P = ^P   Alt-P = !P   DOWN       = \0150
  490.    Ctrl-Q = ^Q   Alt-Q = !Q   PGUP       = \0149   Ctrl-PGUP  = \0184
  491.    Ctrl-R = ^R   Alt-R = !R   PGDN       = \0151   Ctrl-PGDN  = \0176
  492.    Ctrl-S = ^S   Alt-S = !S   HOME       = \0147   Ctrl-HOME  = \0177
  493.    Ctrl-T = ^T   Alt-T = !T   END        = \014F   Ctrl-END   = \0175
  494.    Ctrl-U = ^U   Alt-U = !U
  495.    Ctrl-V = ^V   Alt-V = !V
  496.    Ctrl-W = ^W   Alt-W = !W
  497.    Ctrl-X = ^X   Alt-X = !X
  498.    Ctrl-Y = ^Y   Alt-Y = !Y
  499.    Ctrl-Z = ^Z   Alt-Z = !Z
  500.  
  501.  
  502.          F1  = ~1      Shift-F1    = #1     Ctrl-F1  = ^1       Alt-F1  = !1
  503.          F2  = ~2      Shift-F2    = #2     Ctrl-F2  = ^2       Alt-F2  = !2
  504.          F3  = ~3      Shift-F3    = #3     Ctrl-F3  = ^3       Alt-F3  = !3
  505.          F4  = ~4      Shift-F4    = #4     Ctrl-F4  = ^4       Alt-F4  = !4
  506.          F5  = ~5      Shift-F5    = #5     Ctrl-F5  = ^5       Alt-F5  = !5
  507.          F6  = ~6      Shift-F6    = #6     Ctrl-F6  = ^6       Alt-F6  = !6
  508.          F7  = ~7      Shift-F7    = #7     Ctrl-F7  = ^7       Alt-F7  = !7
  509.          F8  = ~8      Shift-F8    = #8     Ctrl-F8  = ^8       Alt-F8  = !8
  510.          F9  = ~9      Shift-F9    = #9     Ctrl-F9  = ^9       Alt-F9  = !9
  511.          F10 = ~0      Shift-F10 = #0     Ctrl-F10 = ^0       Alt-F10 = !0
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.                                  @X COLOR CODES
  520.                                  --------------
  521.  
  522.     +--------+------------------------------+------------------------------+
  523.     |        |                              |                              |
  524.     |  Code  |      Background Meaning      |      Foreground Meaning      |
  525.     |        |                              |                              |
  526.     +--------+------------------------------+------------------------------+
  527.     |        |                              |                              |
  528.     | 0 ( 0) |      Black       (No Blink)    |         Black                   |
  529.     |        |                              |                              |
  530.     | 1 ( 1) |      Blue          (No Blink)    |         Blue                   |
  531.     |        |                              |                              |
  532.     | 2 ( 2) |      Green       (No Blink)    |         Green                   |
  533.     |        |                              |                              |
  534.     | 3 ( 3) |      Cyan          (No Blink)    |         Cyan                   |
  535.     |        |                              |                              |
  536.     | 4 ( 4) |      Red          (No Blink)    |         Red                   |
  537.     |        |                              |                              |
  538.     | 5 ( 5) |      Magenta      (No Blink)    |         Magenta               |
  539.     |        |                              |                              |
  540.     | 6 ( 6) |      Brown       (No Blink)    |         Brown                   |
  541.     |        |                              |                              |
  542.     | 7 ( 7) |      Light Grey  (No Blink)    |         Light Grey            |
  543.     |        |                              |                              |
  544.     | 8 ( 8) |      Black       (Blink)        |         Dark Grey               |
  545.     |        |                              |                              |
  546.     | 9 ( 9) |      Blue          (Blink)        |         Light Blue            |
  547.     |        |                              |                              |
  548.     | A (10) |      Green       (Blink)        |         Light Green           |
  549.     |        |                              |                              |
  550.     | B (11) |      Cyan          (Blink)        |         Light Cyan            |
  551.     |        |                              |                              |
  552.     | C (12) |      Red          (Blink)        |         Light Red               |
  553.     |        |                              |                              |
  554.     | D (13) |      Magenta      (Blink)        |         Light Magenta           |
  555.     |        |                              |                              |
  556.     | E (14) |      Brown       (Blink)        |         Yellow                |
  557.     |        |                              |                              |
  558.     | F (15) |      Light Grey  (Blink)        |         White                   |
  559.     |        |                              |                              |
  560.     +--------+------------------------------+------------------------------+
  561.  
  562.  
  563. @X color codes are implemented in the following format:  @XBF, where the
  564. B is the background attribute and the F is the foreground attribute,
  565. both taken from the above table.  In other words, @XCF would be flashing
  566. white letters on a red background.  There are two exceptions:
  567.  
  568.  
  569.     @X00 - Save the current attribute
  570.     @XFF - Recall the last attribute saved with @X00
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.                            STARTUP OPTION ATTRIBUTES
  579.                            -------------------------
  580.  
  581. To calculate the attribute (color code) for a startup option (such as
  582. /HELPATTR), take the decimal value (in parenthesis) for the desired
  583. background, multiply it by 16, and add the decimal value (in
  584. parenthesis) for the desired foreground.
  585.  
  586. For example, if you wanted to use flashing bright white letters on a red
  587. background, you would use the following set of calculations:
  588.  
  589.     (B * 16) + F =
  590.     ((RED w/BLINKING FOREGROUND) * 16) + BRIGHT WHITE =
  591.     (12 * 16) + 15 =
  592.     192 + 15 =
  593.     207
  594.  
  595. If you wanted to use that for the help attribute, you would include a
  596. startup option of the following format:
  597.  
  598.     /HELPATTR:207
  599.  
  600.  
  601.  
  602.                               SUPPORT FOR PCBEDIT
  603.                               -------------------
  604.  
  605. If you have a question about PCBEdit, first read this document
  606. completely.  If you wish to report a bug in PCBEdit, read the
  607. HISTORY.TXT document completely.  If you can't find the answer to your
  608. question or a mention of your bug being fixed, then leave a message to
  609. SCOTT ROBISON in the BETA conference (6) on the SALT AIR BBS.  Please
  610. include in the message the wide area beta version number and/or release
  611. date of the software (found at the top of this document and on the
  612. information screen (Alt-W key) in PCBEdit).  Depending on the
  613. circumstances, We may also need to get a copy of the configuration
  614. and/or display files in use at the time, so keep them handy.  However,
  615. you will not need to upload them unless requested.  Remember, this is
  616. *BETA* software.  It is not, nor should it be expected to be perfect.
  617. Be sure to save your work often, and preferably back it up before you
  618. attempt to edit it.  While this program has been tested extensively in
  619. house, you are bound to do something we didn't take into account.
  620. Please report any problems and we will fix them as quickly as possible.
  621.  
  622. Summary:
  623.  
  624.     Use the SALT AIR BBS BETA conference (6) for PCBEdit reports.
  625.     Leave them to SCOTT ROBISON.
  626.     Tell him what version/beta release you are using.
  627.     Be prepared to supply him with samples of configuration and/or
  628.         display files.
  629.     Be patient!  :)
  630.  
  631.  
  632.  
  633.  
  634.  
  635.  
  636.                           ANSWERS TO COMMON QUESTIONS
  637.                           ---------------------------
  638.  
  639. Q:  The Alt-O optimize function doesn't seem to work.  What's wrong?
  640.  
  641. A:  It is being worked on.  We haven't experienced it removing necessary
  642.     codes; it just won't always remove unnecessary codes (which is it's
  643.     function).  It will never be perfect; there are too many potential
  644.     cases for it to reliably take into account.  However, it will
  645.     improve with time.  If you feel you have a case that is OBVIOUSLY
  646.     incorrect, upload the display file to SALT AIR and leave a message
  647.     to SCOTT ROBISON to take a look at it with the PCBEdit Alt-O
  648.     command.
  649.  
  650.  
  651. Q:  PCBEdit saves files with a carriage return/line feed after the last
  652.     line, but I need an end of file character after the last line. Is
  653.     there a way to accomplish this?
  654.  
  655. A:  There are a couple of ways to do this.  One is to position yourself
  656.     at the end of the last line just before saving it and hit ^Z or
  657.     Alt-26 (the EOF character).  Another option, if you want it to save
  658.     that way everytime you save the file, is to use the /LLEND option to
  659.     change the last line ending sequence of characters.  /LLEND:26 will
  660.     save an EOF after the last line instead of a CR-LF.
  661.  
  662.  
  663. Q:  When I change background colors and type spaces all the way to the
  664.     end of the line it displays as expected.  But sometimes if I move
  665.     the cursor off of that line (and always after a save and reload of
  666.     the same file) it background color no longer appears across the
  667.     entire line.  What happened?
  668.  
  669. A:  The effect you desire is automatic when using screen oriented
  670.     editors (such as TheDraw and PCBDraw) because the save the entire
  671.     screen (80X25), and that's why you can only edit that size of
  672.     display with those programs. However, since PCBEdit functions more
  673.     as a text editor instead of a screen editor, it attempts to optimize
  674.     the output of the file before saving by stripping trailing spaces
  675.     before writing the file to disk.  This is easily avoided by simply
  676.     including a color change at the end of the line back to the original
  677.     background color.  For example, to include a blue bar on a line
  678.     (with nothing else) on a line, you could type in something like
  679.     this:
  680.  
  681.         @X00@X1F     @XFF
  682.  
  683.     Since the @XFF appears after the spaces, the spaces are treated as
  684.     significant and are saved with the file.  Since the @XFF only
  685.     performs a color change, nothing textual is displayed after the
  686.     spaces, giving you the desired effect.  Additionally, if you wish to
  687.     have the color change affect the rest of the current line you could
  688.     use an @CLREOL@ macro to change the color of the line.
  689.  
  690.  
  691.  
  692.  
  693.  
  694.  
  695.                           ANSWERS TO COMMON QUESTIONS
  696.                           ---------------------------
  697.  
  698. Q:  I prefer the status bar format from TheDraw and PCBDraw.  Is there
  699.     any way to implement this?
  700.  
  701. A:  It's been there since the original release!  You can use the Alt-T
  702.     key to toggle status line types between the default one, one that
  703.     appears more like the TheDraw/PCBDraw status line, or no status line
  704.     at all.  Or you can use the /STATUS configuration option to select
  705.     which one you want by default (/STATUS syntax and options are
  706.     documented above).
  707.  
  708.  
  709. Q:  If I mark a block to change the color or delete, it also removes the
  710.     color codes and non-displayable macros to the left and right of the
  711.     block.  Why does this happen and is there a way around it?
  712.  
  713. A:  There are three block types:  block, line and character.  Line and
  714.     character are straight forward; they mark a range from the beginning
  715.     to the end and everything in-between without including any extra.  A
  716.     true block (any rectangular region) is a different beast though.  In
  717.     PCBoard display files, one physical character in the document does
  718.     not necessarily equal one displayable character.  For example, @QON@
  719.     does absolutely nothing to the display, but instructs PCBoard to do
  720.     something.  Alternatively, @BOARDNAME@ can potentially be much
  721.     longer than the physical 11 characters it occupies.  PCBEdit needs
  722.     to take these cases (and others) into account in a true rectangular
  723.     block so that it can line up correctly on the left and right sides
  724.     of the block.  The only way around it is to select a line or
  725.     character block instead of a true rectangular screen block.  Make
  726.     sense?  No?  Don't worry about it, just remember that L and C blocks
  727.     are handled differently than B blocks.
  728.  
  729.  
  730.  
  731.  
  732.  
  733.  
  734.                           NEW FEATURES IN VERSION 1.10
  735.                           ----------------------------
  736.  
  737.     The following new macros from PCBoard Version 15.1 are supported in
  738.     PCBEdit Version 1.10:
  739.  
  740.         @ALIAS@     @BYTECREDIT@    @DIRNAME@       @DIRNUM@
  741.         @ENV@       @FBYTES@        @FFILES@        @FILECREDIT@
  742.         @FNUM@      @LOGDATE@       @LOGTIME@       @MAXBYTES@
  743.         @MAXFILES@  @NOCHAR@        @NUMCONF@       @PWXDATE@
  744.         @PWXDAYS@   @RATIOBYTES@    @RATIOFILES@    @YESCHAR@
  745.  
  746.     Note especially the new @ENV@ macro.  The exact syntax for it's use is:
  747.  
  748.         @ENV=VAR@
  749.  
  750.     Where VAR is the name of an environment variable.  The actual
  751.     environment variable should named @VAR@ (it should be surrounded with
  752.     @ symbols).
  753.  
  754.     All of these new @ macros support field width and justification
  755.     specifiers.  In other words, @ALIAS@, @ALIAS:50@, and @ALIAS:50C@ are
  756.     all valid @ macros.
  757.  
  758.